Skip to content

Expand Caching section in README - #423

Merged
sloshy merged 2 commits into
masterfrom
docs/caching-in-readme
Jan 15, 2021
Merged

Expand Caching section in README#423
sloshy merged 2 commits into
masterfrom
docs/caching-in-readme

Conversation

@sloshy

@sloshy sloshy commented Jan 14, 2021

Copy link
Copy Markdown
Contributor

To address #306 which expressed some confusion on how caching and deduplication works, I've expanded the section to contain an example of sharing the cache between successive computations.

A couple other small changes that are tagging along:

  • README should now contain the proper year range (unsure if this will work)
  • Fixed some deprecated usage of filterKeys in the microsite docs

@github-actions github-actions Bot added the documentation Improvements or additions to documentation label Jan 14, 2021
@sloshy
sloshy requested a review from rafaparadela January 14, 2021 20:45
@codecov

codecov Bot commented Jan 14, 2021

Copy link
Copy Markdown

Codecov Report

Merging #423 (997f78d) into master (815b11f) will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##           master     #423   +/-   ##
=======================================
  Coverage   67.55%   67.55%           
=======================================
  Files           8        8           
  Lines         299      299           
  Branches        5        5           
=======================================
  Hits          202      202           
  Misses         97       97           

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 815b11f...997f78d. Read the comment docs.

@rafaparadela rafaparadela left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for expanding such a great explanation

@sloshy
sloshy merged commit db771e0 into master Jan 15, 2021
@sloshy
sloshy deleted the docs/caching-in-readme branch January 15, 2021 00:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants